package com.followmeandroid.messages;

import com.followmeandroid.models.Friend;

import java.util.List;

/**
 * <p>Title: FindFriendResponse</p>
 * <p>Description: Container class for storing
 * responses from the server from a find friend
 * request.</p>
 * @author Adam Drews
 * @email adam.drews@my.uwrf.edu
 * @date 11/23/2014
 * @team Tyler Johnson
 * @email tyler.johnson@my.uwrf.edu
 * @team Nicholas Thorp
 * @email nicholas.thorp@my.uwrf.edu
 */
public class FindFriendResponse {
    private List<Friend> friends; /** A list of Friend objects returned by the server */

    /**
     * Returns a list of Friend objects from the find friend
     * response from the server.
     * @return friends      The list of friends matching a query.
     */
    public List<Friend> getFriends() {
        return friends;
    }

    /**
     * Sets the friends class variable to the list of Friend objects
     * received from the server.
     * @param friends       The list of friends that matched a query.
     */
    public void setFriends(List<Friend> friends) {
        this.friends = friends;
    }
}
